blob: 1e9791021e17174785ddae9ed25ffce1d5e4df35 [file] [log] [blame]
Roger Shimizu0a1f5332021-06-20 21:41:05 +09001.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
Mike Frysingercbd78a92024-04-11 08:32:40 -04002.TH REPO "1" "April 2024" "repo smartsync" "Repo Manual"
Roger Shimizu0a1f5332021-06-20 21:41:05 +09003.SH NAME
4repo \- repo smartsync - manual page for repo smartsync
5.SH SYNOPSIS
6.B repo
7\fI\,smartsync \/\fR[\fI\,<project>\/\fR...]
8.SH DESCRIPTION
9Summary
10.PP
11Update working tree to the latest known good revision
12.SH OPTIONS
13.TP
14\fB\-h\fR, \fB\-\-help\fR
15show this help message and exit
16.TP
17\fB\-j\fR JOBS, \fB\-\-jobs\fR=\fI\,JOBS\/\fR
Mike Frysingerdf8b1cb2021-07-26 15:59:20 -040018number of jobs to run in parallel (default: based on
19number of CPU cores)
Roger Shimizu0a1f5332021-06-20 21:41:05 +090020.TP
21\fB\-\-jobs\-network\fR=\fI\,JOBS\/\fR
22number of network jobs to run in parallel (defaults to
Mike Frysinger7fa8eed2022-08-04 04:27:17 -040023\fB\-\-jobs\fR or 1)
Roger Shimizu0a1f5332021-06-20 21:41:05 +090024.TP
25\fB\-\-jobs\-checkout\fR=\fI\,JOBS\/\fR
26number of local checkout jobs to run in parallel
Mike Frysinger7fa8eed2022-08-04 04:27:17 -040027(defaults to \fB\-\-jobs\fR or 8)
Roger Shimizu0a1f5332021-06-20 21:41:05 +090028.TP
29\fB\-f\fR, \fB\-\-force\-broken\fR
30obsolete option (to be deleted in the future)
31.TP
32\fB\-\-fail\-fast\fR
33stop syncing after first error is hit
34.TP
35\fB\-\-force\-sync\fR
36overwrite an existing git directory if it needs to
37point to a different object directory. WARNING: this
38may cause loss of data
39.TP
Mike Frysingercbd78a92024-04-11 08:32:40 -040040\fB\-\-force\-checkout\fR
41force checkout even if it results in throwing away
42uncommitted modifications. WARNING: this may cause
43loss of data
44.TP
Roger Shimizu0a1f5332021-06-20 21:41:05 +090045\fB\-\-force\-remove\-dirty\fR
46force remove projects with uncommitted modifications
47if projects no longer exist in the manifest. WARNING:
48this may cause loss of data
49.TP
50\fB\-l\fR, \fB\-\-local\-only\fR
51only update working tree, don't fetch
52.TP
53\fB\-\-no\-manifest\-update\fR, \fB\-\-nmu\fR
54use the existing manifest checkout as\-is. (do not
55update to the latest revision)
56.TP
57\fB\-n\fR, \fB\-\-network\-only\fR
58fetch only, don't update working tree
59.TP
60\fB\-d\fR, \fB\-\-detach\fR
61detach projects back to manifest revision
62.TP
63\fB\-c\fR, \fB\-\-current\-branch\fR
64fetch only current branch from server
65.TP
66\fB\-\-no\-current\-branch\fR
67fetch all branches from server
68.TP
69\fB\-m\fR NAME.xml, \fB\-\-manifest\-name\fR=\fI\,NAME\/\fR.xml
70temporary manifest to use for this sync
71.TP
72\fB\-\-clone\-bundle\fR
73enable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS
74.TP
75\fB\-\-no\-clone\-bundle\fR
76disable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS
77.TP
78\fB\-u\fR MANIFEST_SERVER_USERNAME, \fB\-\-manifest\-server\-username\fR=\fI\,MANIFEST_SERVER_USERNAME\/\fR
79username to authenticate with the manifest server
80.TP
81\fB\-p\fR MANIFEST_SERVER_PASSWORD, \fB\-\-manifest\-server\-password\fR=\fI\,MANIFEST_SERVER_PASSWORD\/\fR
82password to authenticate with the manifest server
83.TP
84\fB\-\-fetch\-submodules\fR
85fetch submodules from server
86.TP
87\fB\-\-use\-superproject\fR
Mike Frysingere6601062021-11-12 01:41:29 -050088use the manifest superproject to sync projects;
89implies \fB\-c\fR
Roger Shimizu0a1f5332021-06-20 21:41:05 +090090.TP
91\fB\-\-no\-use\-superproject\fR
92disable use of manifest superprojects
93.TP
94\fB\-\-tags\fR
95fetch tags
96.TP
97\fB\-\-no\-tags\fR
Mike Frysingere6601062021-11-12 01:41:29 -050098don't fetch tags (default)
Roger Shimizu0a1f5332021-06-20 21:41:05 +090099.TP
100\fB\-\-optimized\-fetch\fR
101only fetch projects fixed to sha1 if revision does not
102exist locally
103.TP
104\fB\-\-retry\-fetches\fR=\fI\,RETRY_FETCHES\/\fR
105number of times to retry fetches on transient errors
106.TP
107\fB\-\-prune\fR
108delete refs that no longer exist on the remote
Mike Frysingere6601062021-11-12 01:41:29 -0500109(default)
110.TP
111\fB\-\-no\-prune\fR
112do not delete refs that no longer exist on the remote
LaMont Jones7efab532022-09-01 15:41:12 +0000113.TP
114\fB\-\-auto\-gc\fR
115run garbage collection on all synced projects
116.TP
117\fB\-\-no\-auto\-gc\fR
118do not run garbage collection on any projects
119(default)
Roger Shimizu0a1f5332021-06-20 21:41:05 +0900120.SS Logging options:
121.TP
122\fB\-v\fR, \fB\-\-verbose\fR
123show all output
124.TP
125\fB\-q\fR, \fB\-\-quiet\fR
126only show errors
Mike Frysingerd47d9ff2022-07-10 05:15:19 -0400127.SS Multi\-manifest options:
128.TP
129\fB\-\-outer\-manifest\fR
130operate starting at the outermost manifest
131.TP
132\fB\-\-no\-outer\-manifest\fR
133do not operate on outer manifests
134.TP
135\fB\-\-this\-manifest\-only\fR
136only operate on this (sub)manifest
137.TP
138\fB\-\-no\-this\-manifest\-only\fR, \fB\-\-all\-manifests\fR
139operate on this manifest and its submanifests
Roger Shimizu0a1f5332021-06-20 21:41:05 +0900140.SS repo Version options:
141.TP
142\fB\-\-no\-repo\-verify\fR
143do not verify repo source code
144.PP
145Run `repo help smartsync` to view the detailed manual.
146.SH DETAILS
147.PP
148The 'repo smartsync' command is a shortcut for sync \fB\-s\fR.